home *** CD-ROM | disk | FTP | other *** search
/ Whiteline: delta / whiteline CD Series - delta.iso / tools / utils / akill / addkill.doc next >
Text File  |  1995-11-25  |  11KB  |  266 lines
  1. Addkill
  2. =======
  3.  
  4. Dislaimer
  5. ---------
  6. I cannot be held responsible for damage to any system whether hardware or 
  7. software caused either directly or in-directly by the use of this 
  8. software, you use the program entirely at your own risk.
  9.  
  10. History
  11. -------
  12.  
  13. Addkill started off as a simple program to remove headers on ZIP
  14. archives that I downloaded from PC BBS systems (some of these were
  15. over 2 pages long!).
  16. Then I discovered that some of the archives were corrupted and caused
  17. my program problems , so I included a checking routine to test the
  18. archive before removing the header.
  19. Then I thought , why not add more formats and as is usual the program
  20. grew out of all of my original expectations.
  21.  
  22. The name however stuck.
  23.  
  24. What does Addkill do
  25. --------------------
  26. Addkill will check the following format archives ZIP LZH ARC ZOO
  27.  
  28. If it discovers problems with an archive Addkill will either move it into
  29. a sub-folder called ADDERROR within the original archives folder or a
  30. single defined folder.
  31.  
  32. So a file in c:\bbs\apps\ with a possible problem will be moved into
  33. c:\bbs\apps\adderror\ or your single defined folder and a note logged
  34. in the log file.
  35.  
  36. it will also on request remove any headers from ZIP or LZH files
  37. (I will include ZOO when I'm 100% sure of the format) , the event is
  38. then logged in the log file.
  39.  
  40. It also on request, replaces entries in FILES.BBS with the description
  41. in FILE_ID.DIZ or .UPL files if present in an archive being tested.
  42.  
  43. It can alter any outstanding .TIC files for archives with headers removed 
  44. with the filesize and CRC being updated.
  45.  
  46. It can be told not to check archives/remove headers from files younger
  47. than XX days old.
  48.  
  49. Any errors/headers removed are logged.
  50.  
  51. Configuring Addkill
  52. -------------------
  53. Create a folder for Addkill to keep it's data files in.
  54.  
  55. If you want the 'bad' archives to be stored in a particular folder then 
  56. create that folder also.
  57.  
  58. To make Addkill run automatically you need to create an ADDKILL.LST file
  59. this is just a list of the drives and paths you want Addkill to check the
  60. archives in and is of the following format (example in archive)
  61.  
  62. l:\fdt\download\ l:\fdt\download\
  63. j:\bbs\general\  e:\bbs\apps\
  64. i:\bbs\apps_1\   e:\bbs\apps\
  65. h:\bbs\accs\     h:\bbs\accs\
  66. e:\bbs\APPS\     e:\bbs\apps\
  67. h:\bbs\archive\  h:\bbs\archive\
  68. g:\bbs\bbsprogs\ g:\bbs\bbsprogs\
  69. e:\bbs\dtp\      e:\bbs\dtp\
  70. h:\bbs\comms\    h:\bbs\comms\
  71. h:\bbs\demos\    h:\bbs\demos\
  72. g:\bbs\disk\     g:\bbs\disk\
  73. e:\bbs\falcon\   e:\bbs\falcon\
  74. f:\bbs\games\    f:\bbs\games\
  75. K:\bbs\graphix\  k:\bbs\graphix\
  76. h:\bbs\language\ h:\bbs\language\
  77. g:\bbs\magazine\ g:\bbs\magazine\
  78. i:\bbs\mint\     i:\bbs\mint\
  79. f:\bbs\mod\      f:\bbs\mod\
  80. h:\bbs\music\    h:\bbs\music\
  81. g:\bbs\packers\  g:\bbs\packers\
  82. i:\bbs\psion\    i:\bbs\psion\
  83. h:\bbs\rpg\      h:\bbs\rpg\
  84. h:\bbs\spectrum\ h:\bbs\spectrum\
  85. K:\bbs\ibm\      k:\bbs\ibm\
  86. K:\bbs\doom\     k:\bbs\doom\
  87. i:\bbs\other\    i:\bbs\other\
  88. g:\upload\       g:\upload\
  89. h:\bbs\semper\   h:\bbs\semper\
  90. h:\bbs\jetmail\  h:\bbs\jetmail\
  91. f:\bbs\nodelist\ f:\bbs\nodelist\
  92. f:\bbs\bbs\      f:\bbs\bbs\
  93.  
  94. The first drive and path is the path to the archives , the second is the 
  95. path to the related FILES.BBS file for that download area , this is in 
  96. case you have a single FILES.BBS file for more than one download path (AKA 
  97. OCTOPUS BBS)
  98.  
  99. If you don't want to use the FILE_ID.DIZ/.UPL feature of Addkill then you 
  100. needn't include the second path on the line , but you MUST make sure the
  101. last path in the file has a carriage return at the end.
  102.  
  103. If you want to use the FILE_ID.DIZ/.UPL feature but don't want to use it in a 
  104. particular area then just miss out the second path on the line containing 
  105. that area.
  106.  
  107. If you are going to use the FILE_ID.DIZ/.UPL feature then you may want to 
  108. create an ADVERT.DIZ file , this is because a lot of PC BBSs' now add a 
  109. small advert for their own BBS onto the end of the file_id.diz files , any 
  110. text in the ADVERT.DIZ files will be removed from the description before 
  111. being stored in your files.bbs. (example in archive)
  112.  
  113. This file is just a single line (maximum 50 lines) for each bit of text
  114. to be scanned for, make sure the last path in the file has a carriage
  115. return at the end.
  116.  
  117. <THE GATES-7771-113-5023/0644/5641/7633 >
  118. Call The Tavern BBS 0181-445-6514
  119.  
  120. Running Addkill
  121. ---------------
  122.  
  123. When you first run Addkill you will automatically be asked to configure 
  124. the program , you will be asked the following questions.
  125.  
  126. Whether you want to remove archive headers.
  127. Whether you want to replace file descriptions with FILE_ID.DIZ if present.
  128. Whether you want all 'bad' archives to be stored in one folder.
  129. Whether you want to update any outstanding TIC files.
  130.  
  131. based on these two answers you will be asked some/all of the following
  132. questions.
  133.  
  134. What Type of FILES.BBS entries you want written out
  135. ----------------------------------------------------------------------------
  136. There are 3 options , the types are
  137.  
  138. 1) Line    , this is where the file and description are written out in a
  139.              single long line
  140.  
  141. 2) plus    , this is where the 1st line is the name plus part of the 
  142.              description , the next line is the next part of the 
  143.              description suffixed with a space and + to denote a 
  144.              continuation of the previous description.
  145. example.
  146. --------
  147. ADDRESSE.ZIP [1] Address management as ACC/APP, dialogs in windows, coloured 
  148.  +icons,online scrolling/searching, dialer, XACC, drag & drop, in-/export, 
  149.  +full text search, 3-step sorting, birthday warning etc.The demo loads only 
  150.  +50 addresses, but can be upgraded to the full version with a key (available 
  151.  +from the author).
  152.  
  153. 2) space    , this is where the 1st line is the name plus part of the 
  154.              description , the next line is the next part of the 
  155.              description suffixed with 13 spaces to denote a 
  156.              continuation of the previous description.
  157.  
  158. example
  159. -------
  160. ADDRESSE.ZIP [1] Address management as ACC/APP, dialogs in windows, coloured 
  161.              icons,online scrolling/searching, dialer, XACC, drag & drop,
  162.              in-/export, full text search, 3-step sorting, birthday warning
  163.              etc.The demo loads only 50 addresses, but can be upgraded to
  164.              the full version with a key (available from the author).
  165.  
  166. Option 1 uses the least space but is difficult to edit using a text 
  167.          editor.
  168. Option 2 uses more space , can be edited but not all BBS systems support 
  169.          this type of entry.
  170. Option 3 uses the most space but is more likely to be supported by your BBS
  171.          software.
  172.  
  173. The choice is yours.
  174. ----------------------------------------------------------------------------
  175.  
  176. Maximum Length of the BBS descriptions.
  177.  
  178. Number of minutes to run (0-999) 0 will run without stopping till all
  179.                                  archives are checked
  180.  
  181. Number of days before removing headers (0-999) 0 will check all archives
  182.                                                regardless , any number 
  183.                                                will stop Addkill checking 
  184.                                                the file until the file 
  185.                                                headers shows it is at 
  186.                                                least that old.
  187.  
  188. The reason for this option is for systems that pass files onto other BBS 
  189. but want headers removed , normally changing the CRC might cause the file 
  190. tosser to error out on the destination BBS receiving the file (CRC error).
  191. By limiting the files to be changed to only those over XX days old then 
  192. all your systems should have received the files by XX days and it is then
  193. ok to remove the header without affecting others.
  194.  
  195. Using the .TIC change option will stop the above problem occouring , but 
  196. please note , in some networks , changing any archive being passed through 
  197. your system to another before they collect it is against the networks rules.
  198.                                               
  199. The Path of the TIC files (file selector) , clicking cancel will stop any
  200. turn off the TIC changing.
  201.  
  202. You will be asked to click on the various archivers , clicking on Cancel in
  203. the fileselector will cause the extraction of the FILE_ID.DIZ from that
  204. archive type to be skipped, evan if one exists in the archive.
  205.  
  206. The Path AND Filename of the Log file to use (file selector) , clicking 
  207. cancel will stop any logging taking place.
  208.  
  209. The single Path to store the 'bad' archives in (fileselector), if you
  210. choose this option earlier, you WON'T be able to abort the choice of folder.
  211.  
  212. The Path to keep it's data files in (file selector) , if you hit cancel on
  213. this question you will be asked if you are sure you want to abort the 
  214. configuration , hitting Y will abort the saving of the options you have 
  215. just entered.
  216.  
  217. Once you have answered all the questions correctly you will exit the 
  218. program and re-running it will then run using those settings.
  219.  
  220. Should you wish to re-configure then passing the parameter CONFIG to 
  221. Addkill will re-run the configuration procedure.
  222.  
  223. All configuration data is held within the program file itself.
  224.  
  225. Parameters
  226. ----------
  227.  
  228. Config    - (as above)
  229.  
  230. LIST=     - this forces Addkill to use a list other than ADDKILL.LST and is
  231.             of the format LIST=D:\BBS\DAILY.LST  , note the lack of space
  232.             between the = and the drive,path and filename.
  233.  
  234. PACK      - Forces Addkill to scan it's data files and the directories
  235.             for each and if a file no longer resides in that directory 
  236.             it's name will be removed from the data file.
  237.  
  238. ? or HELP - Displays the possible parameters.
  239.  
  240. running with no parameters makes Addkill look for ADDKILL.LST in the 
  241. current directory , if none is found then a file selector appears , 
  242. hitting Cancel aborts the program , otherwise select the folder you want 
  243. to look at and enter *.* as the name , Addkill will then process that 
  244. directory , if you use the fileselector the FILE_ID.DIZ option will be 
  245. ignored.
  246.  
  247. Should you wish to abort the program during a long run then enter shift 1 
  248. (!) and the Addkill will exit after testing the next archive.
  249.  
  250.  
  251. FILE_ID.DIZ support
  252. ===================
  253. Addkill stores copies of the description in file_id.diz in the same folder
  254. as the listed files.bbs (second path in the Addkill.lst) , so it is not
  255. recommended you use this option on drives which are nearly full. (miss out 
  256. the second path in the Addkill.lst file)
  257.  
  258. the data is stored there until the program is finished for any reason ,
  259. it is then scanned and the files.bbs is checked for matching archives 
  260. ,if found the description is changed to that in the FILE_ID.DIZ file.
  261. If no file is matched then the filename and description is appended to the
  262. bottom of the FILES.BBS.
  263.  
  264. The method Addkill uses has the advantage that only those archives with
  265. file_id.diz files in them will cause the archivers to be run , saving time.
  266.